home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1996 #15 / Monster Media Number 15 (Monster Media)(July 1996).ISO / bbs_util / fdsg211.zip / FDSTAT.DOC < prev    next >
Text File  |  1996-04-11  |  10KB  |  236 lines
  1. FrontDoor Statistics Generator        by Scott Hall 3:712/393 shall@world.net
  2. -----------------------------------------------------------------------------
  3. -----------------------------------------------------------------------------
  4. 0. Index
  5. -----------------------------------------------------------------------------
  6.  
  7.  1. NetMailWare!?!?
  8.  2. AGREEMENT
  9.  3. Requirements
  10.  4. What the hell is FDStat?
  11.  5. What are all those numbers and stuff?
  12.  6. FDStat's FD Major Events Log
  13.  7. Switches
  14.  8. Future Enhancement
  15.  9. Thanks!!
  16. 10. COPYRIGHT
  17. 11. Version History with Fixes and changes documented.
  18. 12. Bug reports
  19.  
  20. -----------------------------------------------------------------------------
  21. 1. NetmailWare!?!?
  22. -----------------------------------------------------------------------------
  23.  
  24. This program is NetmailWare. Which means that you are free to use it as long
  25. as you wish for FREE! If you do plan on using this program all I would like
  26. is a Netmail message. I want to see how far this program gets and how popular
  27. it is/will be (if at all :) ).
  28. My address is Scott Hall at FidoNet 3:712/393 or shall@world.net for e-mail.
  29.  
  30. -----------------------------------------------------------------------------
  31. 2. AGREEMENT
  32. -----------------------------------------------------------------------------
  33.  
  34. This program is running on my system and seems quite safe BUT this program
  35. may have bugs. This program only reads your FrontDoor log files and NEVER
  36. touches any other FrontDoor system files.
  37.  
  38. YOU USE THIS PROGRAM AT YOUR OWN RISK!!
  39.  
  40. I can not be held responsible for any loss, injury or death cause by using
  41. this program. You agree to pay all the costs of any damages and not hold me
  42. responsible for any loss, injury or death caused by this program.
  43.  
  44. You aggree to send me a netmail message.
  45.  
  46. Use of this program constitutes agreement to these conditions mentioned above.
  47.  
  48. -----------------------------------------------------------------------------
  49. 3. Requirements
  50. -----------------------------------------------------------------------------
  51.  
  52. * A FrontDoor log to read.
  53. * All options in FD menu Mailer>Log set to "Yes".
  54. * FD environment variable set to FrontDoor directory
  55.  
  56. -----------------------------------------------------------------------------
  57. 4. What the hell is FDStat?
  58. -----------------------------------------------------------------------------
  59.  
  60. Might it be easier to run the program to find out that?
  61. If so try the program first.... geeze!! :)
  62. A program should self be explainatory don't you think?
  63.  
  64. OK, so hopefully you have seen the nice and informative display. If not
  65. then (Oh No!) you have seen an error message. Follow the programs
  66. instructions or fix the error and try again. If this doesn't fix the
  67. problem send me a message (See bottom of this file).
  68.  
  69. -----------------------------------------------------------------------------
  70. 5. What are all those numbers and stuff?
  71. -----------------------------------------------------------------------------
  72.  
  73. The screen is divided into 6 windows and 3 information lines at the bottom
  74. of the screen.
  75.  
  76. PROCESSING WINDOW
  77.  
  78. Here you can watch (if you are quick!) what part of the FD (FrontDoor) Log
  79. is being processed at that moment.
  80.  
  81. INCOMING/OUTGOING POLLS
  82.  
  83. This display uses 2 windows. The first window is for slow speed connects
  84. and the second for high speed connects. You will notice that slow
  85. speed information is in cyan and high speed information is in green.
  86.  
  87. The columns of information/statistics of these 2 windows are:
  88.  
  89. <modem speed in KBPS>: <no. of pollings at this speed>/<no. of pollers at
  90. this speed> <volume received>/<volume sent> <send CPS rate>/<receive CPS rate>
  91.  
  92. CALLERS
  93.  
  94. Statistics on what Baud rates applied to human callers that FD passed onto
  95. your BBS.
  96.  
  97. Successful Connects = Successfully connected human callers
  98. Failed  = Calls that were not successful (assumed to be failed human callers)
  99. Rejects = Human callers rejected during NU (No Users) event.
  100.           ie. Event>Behaviour>"Allow User during Event" was set to 'No'
  101.  
  102. FILE TRANSFERS
  103.  
  104. Statistic on the type of files sent.
  105. TX      = Transmitted or sent files.
  106. RX      = Recieved files.
  107. DDn     = Count echomail bundles with the file extension in the format.
  108.           <Day><Day><number>. eg 1FC233D0.MO1 (in this MO = Monday)
  109. PKT     = Netmail Packets
  110. TIC     = Tick files
  111. Other   = any other type of file sent (perhaps File Attached Netmail).
  112. Pollers = Total time spent receiving and sending files when you were polled.
  113. Polling = Total time spent receiving and sending files when you were polling.
  114. $       = Phone costs as per FDNODE.CTL (which bears no resemblence to our
  115.           real phone bill costs here in Australia because we don't have
  116.           timed calls.. so Telstra tells us anyway!)
  117.  
  118. ERRORS
  119.  
  120. Pollers  = Errors encountered whilst another system was polling you.
  121. Polling  = Errors encountered whilst your system was was polling another.
  122. RX Files = Errors encountered whilst receiving a file from another system.
  123. TX Files = Errors encountered whilst sending a file to another system.
  124. Pwords   = Password session errors encountered.
  125. Others   = any other error not covered by the above.
  126.  
  127. INFORMATION LINES
  128.  
  129. The third last line shows the begin and end dates of the log being processed.
  130. The second last line shows the last error message found and on the extreem
  131. right is where "Writing..." (ie BBS Screens or statistics to major events
  132. log), "Completed!" or "ABORTED!" (ie. Esc key was detected) is displayed.
  133. The last line shows what log is being processed and where "major events" are
  134. being written to (See next section).
  135.  
  136. -----------------------------------------------------------------------------
  137. 6. FDStat's FD Major Event Log (MEL)
  138. -----------------------------------------------------------------------------
  139.  
  140. FDStat writes all major events found in FD Log to FDSTAT.LOG* In this file
  141. will be found errors, polling and poller events with simplified info. If
  142. you got FDStat to work before why not look in you FD Log directory and
  143. examine FDSTAT.LOG?
  144.  
  145. * This file name may be changed see "Switches" below.
  146.  
  147. -----------------------------------------------------------------------------
  148. 7. Switches
  149. -----------------------------------------------------------------------------
  150.  
  151. FDStat has 6 switches/parameters.
  152.  
  153.  FDStat [/LOG={ [Path] Log File}]  [/OUT={ [Path] Output File }]
  154.         [/BBS={BBS Screen Path}] [/NODE={Node}] [/NoPause] [/NoBeep] "
  155.  
  156.     /LOG=  is used to specify the path & file name of the FD log to be"
  157.            processed. If /LOG is not used it will default to FD.LOG in"
  158.            the FD directory. If only a file name is supplied it will"
  159.            look for it in the FD directory. If a full path and file name"
  160.            is supplied it will process that log file."
  161.  
  162.            *Note*: to use the current directory use /OUT=.\{filename}
  163.  
  164.     /OUT=  is used to direct the output to a path & filename."
  165.            If /OUT is not used it will default to FDSTAT.LOG in the FD "
  166.            directory (See /NODE). If only a file name is supplied it will "
  167.            place it in the FD directory. If a full path and file name is "
  168.            supplied it will place the output there."
  169.  
  170.            *Note*: to use the current directory use /OUT=.\{filename}
  171.  
  172.     /BBS=  Causes BBS style FDSTAT.ANS/ASC/ASL screens from statistics"
  173.            screen to be placed in the supplied directory. (See /NODE)"
  174.            ie. /BBS=C:\BBS\SCREENS\"
  175.  
  176.     /NODE= is used to modify the the filenames FDSTAT.LOG and FDSTAT.ANS/"
  177.            ASC/ASL (BBS Screens) to include a node number."
  178.            ie /NODE=1 will produce FDSTAT1.xxx  Other names not modified."
  179.  
  180.            *Note*: Node number can only be 2 aphanumeric characters long.
  181.  
  182.            *Note*: /NODE could be used to keep multiple days worth of logs
  183.                    and BBS screens for a multinode BBS by using the /NODE=dn
  184.                    where d = day number and n = node number. Thereby
  185.                    FDSTATdn.LOG and FDSTATdn.ASC/ANS/ASL are produced.
  186.  
  187.     /NoPause   means that the program will not pause and wait for you "
  188.     /NP        to acknowledge the error message found in the FD log "
  189.                being processed."
  190.  
  191.     /NoBeep    is used to stop the program from beeping when an an error "
  192.     /NB        message was found in the FD log being processed."
  193.  
  194. ---------------------------------------------------------------------------
  195. 8. Future Enhancements
  196. ---------------------------------------------------------------------------
  197. None planned.
  198.  
  199. ---------------------------------------------------------------------------
  200. 9. Thanks!!!
  201. ---------------------------------------------------------------------------
  202.  
  203. Thanks to:
  204. * David "If you can't make it work atleast make it look good!" Greene
  205.   for his help with this program.
  206. * The ßETA Team: Charlie Smith, Mark Ellis, Jeff Schrunk, Tom Van Overbeke,
  207.   James Ducan, Andrew Blume, Mike Jabour, John Bodoni, Danny Walters and
  208.   Jeremy Idol. Thanks lots guys.
  209.  
  210. ---------------------------------------------------------------------------
  211. 10. COPYRIGHT
  212. ---------------------------------------------------------------------------
  213. FrontDoor and Tick are Copyrighted by their respective owners
  214. and probably Registered Trade Marks or something. You know what I mean...
  215.  
  216. ---------------------------------------------------------------------------
  217. 11. Version History
  218. ---------------------------------------------------------------------------
  219.  
  220. See the file FDSTAT.HIS
  221.  
  222. ---------------------------------------------------------------------------
  223. 12. Bug Reports
  224. ---------------------------------------------------------------------------
  225.  
  226. Send bug reports, praise, hate mail, flames, bombs, flowers, money etc. to:
  227.  
  228. Scott Hall
  229. FidoNet:    3:712/393
  230. e-mail:     shall@world.net
  231.  
  232. ---------------------------------------------------------------------------
  233. The End Finally... don't you just love writting doco? How was the spelling?
  234. ---------------------------------------------------------------------------
  235.  
  236.